/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module shumate.LicenseSh;

private import glib.ConstructionException;
private import glib.Str;
private import glib.c.functions;
private import gobject.ObjectG;
private import gtk.AccessibleIF;
private import gtk.AccessibleT;
private import gtk.BuildableIF;
private import gtk.BuildableT;
private import gtk.ConstraintTargetIF;
private import gtk.ConstraintTargetT;
private import gtk.Widget;
private import shumate.MapSource;
private import shumate.c.functions;
public  import shumate.c.types;


/**
 * A widget that displays license text.
 */
public class LicenseSh : Widget
{
	/** the main Gtk struct */
	protected ShumateLicense* shumateLicense;

	/** Get the main Gtk struct */
	public ShumateLicense* getLicenseShStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return shumateLicense;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)shumateLicense;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (ShumateLicense* shumateLicense, bool ownedRef = false)
	{
		this.shumateLicense = shumateLicense;
		super(cast(GtkWidget*)shumateLicense, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return shumate_license_get_type();
	}

	/**
	 * Creates an instance of #ShumateLicense.
	 *
	 * Returns: a new #ShumateLicense.
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto __p = shumate_license_new();

		if(__p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(ShumateLicense*) __p);
	}

	/** */
	public void appendMapSource(MapSource mapSource)
	{
		shumate_license_append_map_source(shumateLicense, (mapSource is null) ? null : mapSource.getMapSourceStruct());
	}

	/**
	 * Gets the additional license text.
	 *
	 * Returns: the additional license text
	 */
	public string getExtraText()
	{
		return Str.toString(shumate_license_get_extra_text(shumateLicense));
	}

	/**
	 * Get the license's text horizontal alignment.
	 *
	 * Returns: the license's text horizontal alignment.
	 */
	public float getXalign()
	{
		return shumate_license_get_xalign(shumateLicense);
	}

	/** */
	public void prependMapSource(MapSource mapSource)
	{
		shumate_license_prepend_map_source(shumateLicense, (mapSource is null) ? null : mapSource.getMapSourceStruct());
	}

	/** */
	public void removeMapSource(MapSource mapSource)
	{
		shumate_license_remove_map_source(shumateLicense, (mapSource is null) ? null : mapSource.getMapSourceStruct());
	}

	/**
	 * Show the additional license text on the map view.  The text will preceed the
	 * map's licence when displayed. Use "\n" to separate the lines.
	 *
	 * Params:
	 *     text = the additional license text
	 */
	public void setExtraText(string text)
	{
		shumate_license_set_extra_text(shumateLicense, Str.toStringz(text));
	}

	/**
	 * Set the license's text horizontal alignment.
	 *
	 * Params:
	 *     xalign = The license's text horizontal alignment
	 */
	public void setXalign(float xalign)
	{
		shumate_license_set_xalign(shumateLicense, xalign);
	}
}